package com.svs.framework.base.mybatis.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.UnknownTypeHandler;

@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {

	/**
	 * 字段名（例如：config_key）
	 */
	String name() default "";

	/**
	 * java类型 V4.0.6+
	 */
	Class<?> javaType() default void.class;

	/**
	 * jdbc类型 V4.0.6+
	 */
	JdbcType jdbcType() default JdbcType.UNDEFINED;

	/**
	 * 类型处理器注册器 V4.0.6+
	 */
	Class<? extends TypeHandler<?>> typeHandler() default UnknownTypeHandler.class;

	/**
	 * 属性名，若不指定，则根据name()字段名进行驼峰命名法转换（例如：config_key 转换为 configKey）
	 */
	String attrName() default "";

	/**
	 * 标签名
	 */
	String label() default "";

	/**
	 * 字段备注
	 */
	String comment() default "";

	/**
	 * 是否主键（update、delete时的条件）
	 */
	boolean isPK() default false;

	/**
	 * 是否插入字段
	 */
	boolean isInsert() default true;

	/**
	 * 是否更新字段
	 */
	boolean isUpdate() default true;

	/**
	 * 是否更新字段（强制更新）V4.0.5+
	 */
	boolean isUpdateForce() default false;

	/**
	 * 是否是查询字段
	 */
	boolean isQuery() default true;

	/**
	 * 查询类型
	 */
	QueryType queryType() default QueryType.EQ;

	/**
	 * 包含嵌入一个实体
	 */
	Class<?> includeEntity() default Class.class;
}
